Docs: align pytest.mark.xfail and skip parameter signatures with reality (#10094)#14725
Merged
Merged
Conversation
nicoddemus
reviewed
Jul 23, 2026
nicoddemus
force-pushed
the
docs/10094-xfail-skip-docs
branch
from
July 23, 2026 09:54
b6d5d23 to
0107508
Compare
nicoddemus
approved these changes
Jul 23, 2026
nicoddemus
added
the
skip news
nicoddemus
enabled auto-merge (squash)
July 23, 2026 09:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #10094.
This PR fixes the documentation signatures and parameter descriptions for
pytest.mark.xfailandpytest.mark.skipto accurately reflect the codebase.pytest.mark.skip'sreasondefaults to"unconditional skip", notNone.pytest.mark.xfail'sconditiondefaults toNoneinstead ofFalse.pytest.mark.xfail'sraisesparameter explicitly allowsNone.